@walletconnect/jsonrpc-utils

What is @walletconnect/jsonrpc-utils?

@walletconnect/jsonrpc-utils is a utility library for working with JSON-RPC in the context of WalletConnect. It provides tools for creating, validating, and managing JSON-RPC requests and responses, which are essential for communication between clients and servers in a decentralized environment.

What are @walletconnect/jsonrpc-utils's main functionalities?

Creating JSON-RPC Requests

This feature allows you to create a JSON-RPC request. The `formatJsonRpcRequest` function takes a method name and parameters, and returns a properly formatted JSON-RPC request object.

const { formatJsonRpcRequest } = require('@walletconnect/jsonrpc-utils');

const request = formatJsonRpcRequest('eth_sendTransaction', [{ from: '0x...', to: '0x...', value: '0x...' }]);
console.log(request);

Validating JSON-RPC Responses

This feature allows you to validate JSON-RPC responses. The `isJsonRpcResponseSuccess` function checks if a response is successful, while `isJsonRpcResponseError` checks if it contains an error.

const { isJsonRpcResponseSuccess, isJsonRpcResponseError } = require('@walletconnect/jsonrpc-utils');

const response = { jsonrpc: '2.0', result: '0x1', id: 1 };
console.log(isJsonRpcResponseSuccess(response)); // true
console.log(isJsonRpcResponseError(response)); // false

Handling JSON-RPC Errors

This feature allows you to create a JSON-RPC error response. The `formatJsonRpcError` function takes an id and an error message, and returns a properly formatted JSON-RPC error object.

const { formatJsonRpcError } = require('@walletconnect/jsonrpc-utils');

const error = formatJsonRpcError(1, 'Something went wrong');
console.log(error);

Other packages similar to @walletconnect/jsonrpc-utils

json-rpc-engine

json-rpc-engine is a modular JSON-RPC middleware engine for building JSON-RPC servers and clients. It provides a flexible way to handle JSON-RPC requests and responses, similar to @walletconnect/jsonrpc-utils, but with a focus on middleware composition.

jayson

jayson is a full-featured JSON-RPC 2.0/1.0 client and server for Node.js. It offers a comprehensive set of tools for creating and managing JSON-RPC requests and responses, similar to @walletconnect/jsonrpc-utils, but with additional support for server-side operations.

jsonrpc-lite

jsonrpc-lite is a lightweight JSON-RPC 2.0 library for Node.js and the browser. It provides basic utilities for creating and parsing JSON-RPC requests and responses, similar to @walletconnect/jsonrpc-utils, but with a focus on minimalism and simplicity.

README

The README file is missing